home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / Backslash.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  2.5 KB  |  66 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/Backslash.3,v 1.12 93/04/01 09:25:22 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) Backslash.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_Backslash tclc
  32. .BS
  33. .SH NAME
  34. Tcl_Backslash \- parse a backslash sequence
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. char
  40. \fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
  41. .SH ARGUMENTS
  42. .AS char *countPtr
  43. .AP char *src in
  44. Pointer to a string starting with a backslash.
  45. .AP int *countPtr out
  46. If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
  47. in with number of characters in the backslash sequence, including
  48. the backslash character.
  49. .BE
  50.  
  51. .SH DESCRIPTION
  52. .PP
  53. This is a utility procedure used by several of the Tcl
  54. commands.  It parses a backslash sequence and returns
  55. the single character corresponding to the sequence.
  56. \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
  57. of characters in the backslash sequence.
  58. .PP
  59. See the Tcl manual entry for information on the valid
  60. backslash sequences.
  61. All of the sequences described in the Tcl
  62. manual entry are supported by \fBTcl_Backslash\fR.
  63.  
  64. .SH KEYWORDS
  65. backslash, parse
  66.